Update example documentation #23
Conversation
Adapt original Zephyr repo to NCS, including the manifest and the doc. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> Signed-off-by: Markus Tacker <markus.tacker@nordicsemi.no> Signed-off-by: Pekka Niskanen <pekka.niskanen@nordicsemi.no> Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no> Signed-off-by: Vinayak Kariappa Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Add an action which builds and tests application using ncs-docker image.
nrf-squash! [nrf noup] treewide: Adapt to NCS Uses sysbuild when building the application using twister Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
Since the migration to Zoomin, this is no longer possible. Remove the functionality until a workaround is found. Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
Updates the Example Application's document to use the sphinx-ncs-theme v0.7.4, which was the latest version I could get to easily work. Also adds some example pages and documentation guidance. Signed-off-by: Wille Backman <wille.backman@nordicsemi.no>
|
No idea idea how to fix the build error. The documentation builds locally. |
Nordic theme is useful for Nordic teams that move their products to add-ons. I would like it to be available. Can we make it, so it is one of the available options (default or Nordic)? Edit: |
|
In addition to what Wojciech said, the Example Application is still a Nordic offering, so it is good for it to have Nordic styling and quality. I do agree that it would probably be good to document how to change the theme, in which case we can leave the Alabaster theme as a commented-out option in the file. The changed content is likewise good for any Nordic projects, and makes it easier for outside contributors to create documentation that is at least somewhat consistent with Nordic documentation. This, in turn, is good for end users when the add-ons are consistently documented. |
|
Note: Nordic theme is no longer maintained, as we've moved to Zoomin. So at some point it will likely break. |
|
How much of the theme is the CSS (which shouldn't break), and how much is Breathe/Sphinx functionality? |
It depends on rtd theme, and has quite a few tweaks on top, like supporting tabs, version dropdown, etc. I'd not recommend it for external usage. |
gmarull
force-pushed
the
main
branch
3 times, most recently
from
081ac40 to
ce4e811
Compare
Updates the Example Application's document to use
the sphinx-ncs-theme v0.7.4, which was the latest version I could get to easily work.
Also adds some example pages and documentation guidance.